sgo-ux

POST: /agreement

url

https://nonprod.cwp.esb.cloud.lla.com/dev/sgo-ux-cwp/sgo-ux/v1/{businessId}/agreement

Key Considerations for Bulk alter handset to enable tradeIn Functionality

1. TradeIn functionality is applicable only with agreementType as renewWithHandset.
2. TradeIn is applicable for POSTPAID products for B2C Customers.
3. handsetBrand, handsetModel, tradeInIndicator, tradeInAmount are the new fields expected from SGO.
4. To enable the tradeIn Functionality SGO should send tradeInIndicator as Y, then only ESB will consider this request as tradeIn Request. If tradeInIndicator is Y then it is assumed that all business unit parameters are already validated and ok for tradeIn and ESB will not validate further whether the tradeIn parameters are set to Y or not.
5. tradeInAmount from SGO is always greater than 0.
6. If tradeInIndicator is other than Y, existing flows of implementation will be applicable in ESB.
7. ESB doesn't perform any validation on handsetBrand, handsetModel and deviceNumber sent from SGO.
8. handsetReplacementIndicator will be N, when tradeInIndicator and anticipateRenewInd from SGO are sent as Y.

Request Body

{
    "agreementType": "RenewWithHandset",
    "name": "1",
    "status": "Renew",
    "agreementItem": [
        {
            "product": [
                {
                    "id": "222122",
                    "name": "product_name",
                    "@type": "Product"
                },
                {
                    "id": "HSAA54B2BFULL",
                    "name": "Handset Device ID",
                    "@type": "Device"
                },
                {
                    "id": "412885",
                    "name": "ServiceNo-62160644",
                    "@type": "Service"
                }
            ],
            "productOffering": [
                {
                    "id": "",
                    "name": "promoCode"
                }
            ]
        }
    ],
    "characteristic": [
        {
            "name": "penaltyPeriod",
            "value": "1"
        },
        {
            "name": "subsidyPaid",
            "value": "N"
        },
        {
            "name": "discount",
            "value": "0"
        },
        {
            "name": "devicePrice",
            "value": "355"
        },
        {
            "name": "pendSubdyTransId",
            "value": "0"
        },
        {
            "name": "specInstrTextContract",
            "value": "Test"
        },
        {
            "name": "antiRenewalApprovalInd",
            "value": "N"
        },
        {
            "name": "handInstalAmtPend",
            "value": "0"
        },
        {
            "name": "handTransId",
            "value": "0"
        },
         {

            "name": "upfrontPayment",
            "value": "0"
        },
        {
            "name": "handsetBrand",
            "value": "IPHONE"
        },
        {
            "name": "handsetModel",
            "value": "16PROMAX"
        },
        {

            "name": "tradeInAmount",
            "value": "91.42"
        },
        {

            "name": "tradeInIndicator",
            "value": "Y"
        },
        {
            "name": "handsetReplInd",
            "value": "Y"
        },
        {
            "name" : "anticipateRenewInd",
            "value": "N"
        },
        {
            "name": "paymentPeriod",
            "value": "1"
        },
        {
            "name": "duration",
            "value": "1"
        }
      ],
      "engagedParty": [
          {
              "id": "347087960000",
              "role": "billingAccount",
              "@type": "billingAccount"
          },
          {
              "id": "99999",
              "role": "Seller",
              "@type": "Seller"
          }
    ],
    "@type": "Agreement"
}

Response

{
    "status": "Success",
    "Name": "1",
    "engagedParty": [
        {
            "id": "347087960000",
            "role": "billingAccount",
            "@type": "billingAccount"
        },
        {
            "id": "99999",
            "role": "Seller",
            "@type": "Seller"
        }
    ]
}